Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Desktop Modeler connector template documentation #4187

Merged
merged 20 commits into from
Aug 28, 2024
Merged

Update Desktop Modeler connector template documentation #4187

merged 20 commits into from
Aug 28, 2024

Conversation

nikku
Copy link
Member

@nikku nikku commented Aug 22, 2024 •
edited
Loading

Description

As per camunda/camunda-modeler#4455 pre-built connector templates are now offered automatically within the Desktop Modeler. This PR reflects that change in documentation and flags.

This also backports the changes to 8.5, the latest released version.

Related to camunda/camunda-modeler#4474

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

This is a follow-up for #3870.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 22, 2024 •
edited
Loading

👋 🤖 🤔 Hello! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.5/.

  • docs/reference/release-notes/860.md
These files were changed only in versioned_docs/version-8.5/. You might want to duplicate these changes in docs/.
  • versioned_docs/version-8.5/components/modeler/desktop-modeler/img/use-connectors/apply.png
  • versioned_docs/version-8.5/components/modeler/desktop-modeler/img/use-connectors/error.png
  • versioned_docs/version-8.5/components/modeler/desktop-modeler/img/use-connectors/up-to-date.png

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

This was referenced Aug 22, 2024
Merged
Closed
@nikku nikku changed the title FOOP: UPDATE CONNECTORS Update Desktop Modeler connector template documentation Aug 22, 2024
@nikku nikku self-assigned this Aug 22, 2024
@nikku nikku added component:connectors Issues related to the connectors project. component:desktop-modeler Issues related with Desktop Modeler 8.6.0-alpha5 September 2024 alpha release labels Aug 22, 2024
@nikku nikku requested review from crobbins215, mesellings, a team, philippfromme and barmac and removed request for a team August 22, 2024 16:55
@nikku nikku marked this pull request as ready for review August 22, 2024 16:55
barmac
barmac previously approved these changes Aug 23, 2024
View reviewed changes
@nikku nikku force-pushed the update-connectors-enabled-per-default branch from 13bb530 to d82bd8e Compare August 26, 2024 07:25
@nikku
Copy link
Member Author

nikku commented Aug 26, 2024

0c69b27 added to support camunda/camunda-modeler#4479.

@nikku nikku mentioned this pull request Aug 26, 2024
Merged
4 tasks
@nikku nikku requested a review from a team August 26, 2024 08:34
@barmac
Copy link
Contributor

barmac commented Aug 26, 2024

There are still some places to update with the flag change, but overall it looks good.

nikku and others added 4 commits August 26, 2024 14:55
@nikku @barmac
Update versioned_docs/version-8.5/components/modeler/desktop-modeler/…
d01bebb 
…flags/flags.md

Co-authored-by: Maciej Barelkowski <maciej.barelkowski@camunda.com>
@nikku @barmac
Update docs/components/modeler/desktop-modeler/use-connectors.md
caa3a23 
Co-authored-by: Maciej Barelkowski <maciej.barelkowski@camunda.com>
@nikku @barmac
Update versioned_docs/version-8.5/components/modeler/desktop-modeler/…
8a83453 
…use-connectors.md

Co-authored-by: Maciej Barelkowski <maciej.barelkowski@camunda.com>
@nikku @barmac
Update docs/components/modeler/desktop-modeler/flags/flags.md
7344614 
Co-authored-by: Maciej Barelkowski <maciej.barelkowski@camunda.com>
@nikku nikku requested a review from barmac August 26, 2024 12:55
@nikku
Copy link
Member Author

nikku commented Aug 26, 2024

My appologies. Not sure how I missed these changes 🙈

barmac
barmac previously approved these changes Aug 26, 2024
View reviewed changes
@conceptualshark conceptualshark self-requested a review August 27, 2024 12:39
conceptualshark
conceptualshark requested changes Aug 27, 2024
View reviewed changes
Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I pushed a few changes to clean up the organization/linking on this page, and this seems pretty good to go.

However, the old enable version of the feature flag is still referenced in the release notes. I couldn't find any updated copy for this section, and wasn't sure if it should come from Product vs my own edits.

@nikku
Copy link
Member Author

nikku commented Aug 27, 2024

However, the old enable version of the feature flag is still referenced in the release notes. I couldn't find any updated copy for this section, and wasn't sure if it should come from Product vs my own edits.

Good catch. This should now link to the use-connectors.md page with the note that you can disable (opt out) via link to use-connectors.md#disable-automatic-connector-template-fetching.

nikku
nikku commented Aug 27, 2024
View reviewed changes
docs/components/modeler/desktop-modeler/use-connectors.md Outdated

## Add Connector templates manually

For full control over building blocks offered by the Desktop Modeler, download element templates for individual Camunda 8 Connectors manually, i.e. through the [Camunda Marketplace](https://marketplace.camunda.com/). Make them available to the Desktop Modeler via the [standard element template search paths](./element-templates/configuring-templates.md).
For full control over the building blocks offered by Desktop Modeler, download element templates for individual Camunda 8 Connectors manually (for example, through the [Camunda Marketplace](/components/modeler/web-modeler/camunda-marketplace.md)). Make them available to Desktop Modeler via the element template [search paths](./element-templates/configuring-templates.md).
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@conceptualshark I believe we should revert this change of the link.

From the Desktop Modeler the market place is not available as shown in the linked URL, nor is any of the "integrated UI".

@nikku
Copy link
Member Author

nikku commented Aug 27, 2024

@conceptualshark Cf. 27cabcd#r1732955161. I'll revert the change of URL and update the release notes according to #4187 (comment).

nikku
nikku commented Aug 27, 2024
View reviewed changes
Copy link
Member Author

@nikku nikku left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@conceptualshark Please see my latest updates

  • restoring the link
  • re-phrasing the 8.6 release notes section

conceptualshark
conceptualshark previously approved these changes Aug 27, 2024
View reviewed changes
Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the catch on the link, and the updates! LGTM! 👍

@nikku nikku requested a review from christinaausley August 28, 2024 09:11
@nikku nikku merged commit dcff172 into main Aug 28, 2024
8 checks passed
@nikku nikku deleted the update-connectors-enabled-per-default branch August 28, 2024 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@christinaausley christinaausley christinaausley approved these changes

@barmac barmac barmac left review comments

@conceptualshark conceptualshark conceptualshark left review comments

@crobbins215 crobbins215 Awaiting requested review from crobbins215

@mesellings mesellings Awaiting requested review from mesellings

@philippfromme philippfromme Awaiting requested review from philippfromme philippfromme was automatically assigned from camunda/modeling-dev

Assignees

@nikku nikku

Labels
8.6.0-alpha5 September 2024 alpha release component:connectors Issues related to the connectors project. component:desktop-modeler Issues related with Desktop Modeler
Projects
Documentation Team
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@nikku @barmac @conceptualshark @christinaausley